LotusScript Doc

Class: LSAPostalAddress

Extends the class LSAPostalAddressItem to handle special needs of postal addresses as responses in LSA-Address

Version:
1.2.4, 01.AUG.2000 <BR>
History:
01.AUG.2000MethodhasAttributeChanged bug for ParentID
08.JUN.2000Methoddelete changed



Property Summary
Public Property Set AddrDataID As String
Public Property Get AddrDataID As String
Public Property Get AddrDataInstance As Variant
Public Property Get AddressData As String
Public Property Get AddressOwner As String
Public Property Set AddressOwner As String
Public Property Get ContextDoc As NotesDocument
Public Property Set ContextDoc As NotesDocument
Public Property Get ParentID As String
Public Property Set ParentID As String
Public Property Get ViewIndex As String

Method Summary
Sub Delete ()
Sub Explode (SerialData As String)
Sub fillFromDoc (doc As NotesDocument)
Function hasAttributeChanged (attrName As String) As Integer
Function hasChanged () As Integer
Function implode () As String
Sub New (addrDataID As String, NewKey As String, NewCareOfName As String, NewBuilding As String, NewRoom As String, NewStreet As String, NewStreetNo As String, NewPostBox As String, NewZip As String, NewCity As String, NewCountry As String, NewState As String)
Function Save (parentDoc As NotesDocument) As Integer
Sub UpdateReferenceS (ViewAllOrgaDocs As NotesView)
Sub Validate ()

Property Detail

Public Property Set AddrDataID AsString

Sets the Instance ID of the LSAAddressData object. If this ID isn't available then the properties Label, Opening and Closing cannot be computed correctly because the property DefaultData of the class isn't available. The ID is set by the object LSAAddressData when this object is accessed via the Property "PostalAddresses" of the class LSAAddressData.

Summmary Top

Public Property Get AddrDataID AsString

Summmary Top

Public Property Get AddrDataInstance AsVariant

If the property AddressDataID is set to an correct Instance ID of the LSAAddressData object which can be obtained by the instance manager class this property returns a handle to object.

Summmary Top

Public Property Get ParentID AsString

Returns the internal key of the document to which the PostalAddress is a response document

Summmary Top

Public Property Set ParentID AsString

Summmary Top

Public Property Get AddressOwner AsString

Returns the name or hierarchical name of the unit to which this postal address is a response to.

Summmary Top

Public Property Set AddressOwner AsString

Summmary Top

Public Property Get ViewIndex AsString

Returns the information which is displayed in the address views. It is the formatted string of the underlying class. This value is stored to the field LSAViewIndex by the method SaveToPredefinedFields.

Summmary Top

Public Property Get AddressData AsString

Returns the serialdata string which is provided by the method implode of the super class. This value is stored in the field LSAAddressInfo by the method SaveToPredefinedFields

Summmary Top

Public Property Get ContextDoc AsNotesDocument

Returns the Lotus Notes response document which is associated with this postal address.

Summmary Top

Public Property Set ContextDoc AsNotesDocument

Summmary Top
Method Detail

New

Public Sub New(addrDataID As String,NewKey As String,NewCareOfName As String,NewBuilding As String,NewRoom As String,NewStreet As String,NewStreetNo As String,NewPostBox As String,NewZip As String,NewCity As String,NewCountry As String,NewState As String)
Summmary Top

Delete

Public Sub Delete
Summmary Top

Validate

Public Sub Validate
Checks that the properties "AddressOwner" and "ParentID" are set. The validate routine of the super class is called to check if the data is valid.

Summmary Top

implode

Public Function implode As String
To use the postal address class together with the LSANamedList class the implode of the LSAPostalAddressItem class must be enhanced with the values of the ParentID and AddressOwner property

Summmary Top

Explode

Public Sub Explode(SerialData As String)
Because the implode functionality enhances the implode method of the super class, the explode method has to be adapted. After implode the new parent information will be synchronizes with the old

Summmary Top

Save

Public Function Save(parentDoc As NotesDocument) As Integer
Saves the object to the Lotus Notes Document which is provided by attribute ContextDoc and makes it a response document to the document which is provided by the parameter ParentDoc

Summmary Top

UpdateReferenceS

Public Sub UpdateReferenceS(ViewAllOrgaDocs As NotesView)
Summmary Top

fillFromDoc

Public Sub fillFromDoc(doc As NotesDocument)
Summmary Top

hasAttributeChanged

Public Function hasAttributeChanged(attrName As String) As Integer
Checks if the attribute with the name attrName has heen changed. Possible values are ADDRESSOWNER and PARENTID and all values which can be inserted in corresponding method of the super class

Parameters:
attrNameStringthe name of the attribute to check
Returns:
booleantrue, if the attribute has changed
History:
01.AUG.2000RGRParentID was compared to ""
Summmary Top

hasChanged

Public Function hasChanged As Integer
Checks one of the objects attributes has been changed @returns true, if addressowner, parentid or an attribute of the superclass has been changed

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:45:34 AM